Skip to content

Add QA steps requirements to copilot agent instructions#5448

Merged
Lukewh merged 5 commits intomainfrom
copilot/fix-53057619-100534315-1719bfbb-4a1a-46ec-8717-8f5835138475
Nov 28, 2025
Merged

Add QA steps requirements to copilot agent instructions#5448
Lukewh merged 5 commits intomainfrom
copilot/fix-53057619-100534315-1719bfbb-4a1a-46ec-8717-8f5835138475

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Nov 3, 2025

Agents now must include QA steps in PR descriptions and verify them during code review.

Changes

Updated .github/copilot-instructions.md to add:

  • Pull Request Guidelines section

    • Mandates clear "How to QA" instructions in every PR description
    • Provides format template and specific guidance for UI changes, API changes, bug fixes, and refactoring
    • Defines required context (issue link, change explanation, prerequisites, screenshots, state/data setup)
    • Includes guidance for achieving specific app state or data shape when needed
  • Verify QA Steps (CRITICAL) in Code Review Guidelines

    • Requires checking for QA instructions before proceeding with review
    • Instructs agents to attempt running QA steps whenever possible
    • Mandates documenting QA verification results
  • Highlight Areas Needing Attention enhancements

    • Added flagging of missing/incomplete QA steps
    • Added highlighting of unclear QA instructions

Format Example

## How to QA
1. Start the app: `dotrun`
2. Navigate to: [specific URL or path]
3. [Specific action to take]
4. Verify: [Expected outcome]
5. [Additional steps as needed]

Aligns with existing PR template which already includes "How to QA" section. Template uses dotrun directly as it includes necessary build steps.

Original prompt

Improve copilot agent instructions to tell agent to always include QA steps for reviewers in the PR description. Also, when agent is reviewing the PR it should make sure that PR has QA instructions, and if possible it should try to run/verify those on the PR code.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@webteam-app
Copy link
Copy Markdown

Copilot is not a collaborator of the repo

Copilot AI changed the title Improve copilot agent instructions to tell agent to always include QA steps for reviewers in the PR description. Also, when agent is reviewing the PR it should make sure that PR has QA instructions, and if possible it should try to run/verify those on ... Add QA steps requirements to copilot agent instructions Nov 3, 2025
Copilot AI requested a review from bartaz November 3, 2025 15:23
Copy link
Copy Markdown
Member

@bartaz bartaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update based on inline comments.

Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md
Copilot AI requested a review from bartaz November 3, 2025 18:13
@bartaz bartaz force-pushed the copilot/fix-53057619-100534315-1719bfbb-4a1a-46ec-8717-8f5835138475 branch from 055fbef to ddbbc29 Compare November 3, 2025 18:36
@bartaz bartaz force-pushed the copilot/fix-53057619-100534315-1719bfbb-4a1a-46ec-8717-8f5835138475 branch from ddbbc29 to 5f4107c Compare November 13, 2025 12:20
Copy link
Copy Markdown
Member

@bartaz bartaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@bartaz bartaz marked this pull request as ready for review November 13, 2025 12:23
Copilot AI review requested due to automatic review settings November 13, 2025 12:23
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR enhances the copilot agent instructions to mandate inclusion and verification of QA steps in pull requests. The changes ensure that both PR authors and reviewers follow a structured approach to quality assurance, aligning with the existing PR template structure.

Key changes:

  • Adds comprehensive "Pull Request Guidelines" section with mandatory QA steps requirements and format templates
  • Introduces "Verify QA Steps (CRITICAL)" subsection in Code Review Guidelines requiring reviewers to check and attempt running QA instructions
  • Updates "Highlight Areas Needing Attention" to flag missing or unclear QA steps

Copilot AI and others added 2 commits November 17, 2025 13:57
Co-authored-by: bartaz <83575+bartaz@users.noreply.github.com>
Co-authored-by: bartaz <83575+bartaz@users.noreply.github.com>
@bartaz bartaz force-pushed the copilot/fix-53057619-100534315-1719bfbb-4a1a-46ec-8717-8f5835138475 branch from 5f4107c to 58ad746 Compare November 17, 2025 12:57
@bartaz bartaz requested a review from Lukewh November 27, 2025 15:17
Copy link
Copy Markdown
Contributor

@Lukewh Lukewh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 LGTM

@Lukewh Lukewh merged commit 8cabc1a into main Nov 28, 2025
13 checks passed
@Lukewh Lukewh deleted the copilot/fix-53057619-100534315-1719bfbb-4a1a-46ec-8717-8f5835138475 branch November 28, 2025 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants